curl --request POST \
--url https://{client_id}.shipstream.app/api/global/v1/shipping/shipments/{id}/pack \
--header 'Content-Type: application/json' \
--data '{
"packages": [
{
"type": "ShipmentPackage",
"id": 123,
"actual_weight": {
"value": 20,
"unit": "lb"
},
"dimensions": {
"length": 8,
"width": 6,
"height": 4,
"unit": "in"
},
"customs_value": {
"amount": 99,
"currency": "USD"
},
"declared_value": {
"amount": 99,
"currency": "USD"
},
"regulation_type": "normal",
"tracking_number": "<string>",
"tracking_description": "<string>",
"tracking_url": "<string>",
"tracking_ref": "<string>",
"alt_tracking_number": "<string>",
"alt_tracking_description": "<string>",
"billable_weight": {
"value": 20,
"unit": "lb"
},
"dimensional_weight": {
"value": 20,
"unit": "lb"
},
"dimensional_weight_divisor": {
"value": 139,
"unit": "in^3/lb"
},
"total_item_volume": {
"value": 300,
"unit": "in^3"
},
"total_void_percent": 123,
"container_style": "rigid_box",
"num_cartons": 123,
"sscc": "<string>",
"manifest_code": "<string>",
"items": [
{
"sku": "<string>",
"name": "<string>",
"quantity": 123,
"weight": {
"value": 20,
"unit": "lb"
},
"hazmat_unit_weight": {
"value": 20,
"unit": "lb"
},
"customs_value": {
"amount": 99,
"currency": "USD"
},
"order_item_id": 123,
"order_item_sku": "<string>",
"order_item_quantity": 123
}
],
"container": {
"type": "Product",
"id": 3
},
"infill": {
"type": "Product",
"id": 3
},
"packaging": {
"product": {
"type": "Product",
"id": 3
},
"quantity": 4
},
"collected_data": {
"label": "<string>",
"value": "<string>"
}
}
]
}'
This response does not have an example.
Completes the packing of a Shipment
in the “picked” status specified by its id
path parameter.
curl --request POST \
--url https://{client_id}.shipstream.app/api/global/v1/shipping/shipments/{id}/pack \
--header 'Content-Type: application/json' \
--data '{
"packages": [
{
"type": "ShipmentPackage",
"id": 123,
"actual_weight": {
"value": 20,
"unit": "lb"
},
"dimensions": {
"length": 8,
"width": 6,
"height": 4,
"unit": "in"
},
"customs_value": {
"amount": 99,
"currency": "USD"
},
"declared_value": {
"amount": 99,
"currency": "USD"
},
"regulation_type": "normal",
"tracking_number": "<string>",
"tracking_description": "<string>",
"tracking_url": "<string>",
"tracking_ref": "<string>",
"alt_tracking_number": "<string>",
"alt_tracking_description": "<string>",
"billable_weight": {
"value": 20,
"unit": "lb"
},
"dimensional_weight": {
"value": 20,
"unit": "lb"
},
"dimensional_weight_divisor": {
"value": 139,
"unit": "in^3/lb"
},
"total_item_volume": {
"value": 300,
"unit": "in^3"
},
"total_void_percent": 123,
"container_style": "rigid_box",
"num_cartons": 123,
"sscc": "<string>",
"manifest_code": "<string>",
"items": [
{
"sku": "<string>",
"name": "<string>",
"quantity": 123,
"weight": {
"value": 20,
"unit": "lb"
},
"hazmat_unit_weight": {
"value": 20,
"unit": "lb"
},
"customs_value": {
"amount": 99,
"currency": "USD"
},
"order_item_id": 123,
"order_item_sku": "<string>",
"order_item_quantity": 123
}
],
"container": {
"type": "Product",
"id": 3
},
"infill": {
"type": "Product",
"id": 3
},
"packaging": {
"product": {
"type": "Product",
"id": 3
},
"quantity": 4
},
"collected_data": {
"label": "<string>",
"value": "<string>"
}
}
]
}'
This response does not have an example.
The id
of the referenced Shipment
.
x >= 1
The body is of type object
.
OK - The operation completed successfully and there is no response body.